<?php


/**
 * Base class that represents a query for the 'ratesgroup' table.
 *
 *
 *
 * @method RatesgroupQuery orderById($order = Criteria::ASC) Order by the id column
 * @method RatesgroupQuery orderByBranchId($order = Criteria::ASC) Order by the branch_id column
 * @method RatesgroupQuery orderByBranchDealerId($order = Criteria::ASC) Order by the branch_dealer_id column
 * @method RatesgroupQuery orderByQuarter($order = Criteria::ASC) Order by the quarter column
 * @method RatesgroupQuery orderByYear($order = Criteria::ASC) Order by the year column
 *
 * @method RatesgroupQuery groupById() Group by the id column
 * @method RatesgroupQuery groupByBranchId() Group by the branch_id column
 * @method RatesgroupQuery groupByBranchDealerId() Group by the branch_dealer_id column
 * @method RatesgroupQuery groupByQuarter() Group by the quarter column
 * @method RatesgroupQuery groupByYear() Group by the year column
 *
 * @method RatesgroupQuery leftJoin($relation) Adds a LEFT JOIN clause to the query
 * @method RatesgroupQuery rightJoin($relation) Adds a RIGHT JOIN clause to the query
 * @method RatesgroupQuery innerJoin($relation) Adds a INNER JOIN clause to the query
 *
 * @method RatesgroupQuery leftJoinBranch($relationAlias = null) Adds a LEFT JOIN clause to the query using the Branch relation
 * @method RatesgroupQuery rightJoinBranch($relationAlias = null) Adds a RIGHT JOIN clause to the query using the Branch relation
 * @method RatesgroupQuery innerJoinBranch($relationAlias = null) Adds a INNER JOIN clause to the query using the Branch relation
 *
 * @method RatesgroupQuery leftJoinSinglerate($relationAlias = null) Adds a LEFT JOIN clause to the query using the Singlerate relation
 * @method RatesgroupQuery rightJoinSinglerate($relationAlias = null) Adds a RIGHT JOIN clause to the query using the Singlerate relation
 * @method RatesgroupQuery innerJoinSinglerate($relationAlias = null) Adds a INNER JOIN clause to the query using the Singlerate relation
 *
 * @method Ratesgroup findOne(PropelPDO $con = null) Return the first Ratesgroup matching the query
 * @method Ratesgroup findOneOrCreate(PropelPDO $con = null) Return the first Ratesgroup matching the query, or a new Ratesgroup object populated from the query conditions when no match is found
 *
 * @method Ratesgroup findOneById(int $id) Return the first Ratesgroup filtered by the id column
 * @method Ratesgroup findOneByBranchId(int $branch_id) Return the first Ratesgroup filtered by the branch_id column
 * @method Ratesgroup findOneByBranchDealerId(int $branch_dealer_id) Return the first Ratesgroup filtered by the branch_dealer_id column
 * @method Ratesgroup findOneByQuarter(int $quarter) Return the first Ratesgroup filtered by the quarter column
 * @method Ratesgroup findOneByYear(string $year) Return the first Ratesgroup filtered by the year column
 *
 * @method array findById(int $id) Return Ratesgroup objects filtered by the id column
 * @method array findByBranchId(int $branch_id) Return Ratesgroup objects filtered by the branch_id column
 * @method array findByBranchDealerId(int $branch_dealer_id) Return Ratesgroup objects filtered by the branch_dealer_id column
 * @method array findByQuarter(int $quarter) Return Ratesgroup objects filtered by the quarter column
 * @method array findByYear(string $year) Return Ratesgroup objects filtered by the year column
 *
 * @package    propel.generator..om
 */
abstract class BaseRatesgroupQuery extends ModelCriteria
{
    /**
     * Initializes internal state of BaseRatesgroupQuery object.
     *
     * @param     string $dbName The dabase name
     * @param     string $modelName The phpName of a model, e.g. 'Book'
     * @param     string $modelAlias The alias for the model in this query, e.g. 'b'
     */
    public function __construct($dbName = 'vw_score_card', $modelName = 'Ratesgroup', $modelAlias = null)
    {
        parent::__construct($dbName, $modelName, $modelAlias);
    }

    /**
     * Returns a new RatesgroupQuery object.
     *
     * @param     string $modelAlias The alias of a model in the query
     * @param     RatesgroupQuery|Criteria $criteria Optional Criteria to build the query from
     *
     * @return RatesgroupQuery
     */
    public static function create($modelAlias = null, $criteria = null)
    {
        if ($criteria instanceof RatesgroupQuery) {
            return $criteria;
        }
        $query = new RatesgroupQuery();
        if (null !== $modelAlias) {
            $query->setModelAlias($modelAlias);
        }
        if ($criteria instanceof Criteria) {
            $query->mergeWith($criteria);
        }

        return $query;
    }

    /**
     * Find object by primary key.
     * Propel uses the instance pool to skip the database if the object exists.
     * Go fast if the query is untouched.
     *
     * <code>
     * $obj  = $c->findPk(12, $con);
     * </code>
     *
     * @param mixed $key Primary key to use for the query
     * @param     PropelPDO $con an optional connection object
     *
     * @return   Ratesgroup|Ratesgroup[]|mixed the result, formatted by the current formatter
     */
    public function findPk($key, $con = null)
    {
        if ($key === null) {
            return null;
        }
        if ((null !== ($obj = RatesgroupPeer::getInstanceFromPool((string) $key))) && !$this->formatter) {
            // the object is alredy in the instance pool
            return $obj;
        }
        if ($con === null) {
            $con = Propel::getConnection(RatesgroupPeer::DATABASE_NAME, Propel::CONNECTION_READ);
        }
        $this->basePreSelect($con);
        if ($this->formatter || $this->modelAlias || $this->with || $this->select
         || $this->selectColumns || $this->asColumns || $this->selectModifiers
         || $this->map || $this->having || $this->joins) {
            return $this->findPkComplex($key, $con);
        } else {
            return $this->findPkSimple($key, $con);
        }
    }

    /**
     * Find object by primary key using raw SQL to go fast.
     * Bypass doSelect() and the object formatter by using generated code.
     *
     * @param     mixed $key Primary key to use for the query
     * @param     PropelPDO $con A connection object
     *
     * @return   Ratesgroup A model object, or null if the key is not found
     * @throws   PropelException
     */
    protected function findPkSimple($key, $con)
    {
        $sql = 'SELECT `ID`, `BRANCH_ID`, `BRANCH_DEALER_ID`, `QUARTER`, `YEAR` FROM `ratesgroup` WHERE `ID` = :p0';
        try {
            $stmt = $con->prepare($sql);
            $stmt->bindValue(':p0', $key, PDO::PARAM_INT);
            $stmt->execute();
        } catch (Exception $e) {
            Propel::log($e->getMessage(), Propel::LOG_ERR);
            throw new PropelException(sprintf('Unable to execute SELECT statement [%s]', $sql), $e);
        }
        $obj = null;
        if ($row = $stmt->fetch(PDO::FETCH_NUM)) {
            $obj = new Ratesgroup();
            $obj->hydrate($row);
            RatesgroupPeer::addInstanceToPool($obj, (string) $key);
        }
        $stmt->closeCursor();

        return $obj;
    }

    /**
     * Find object by primary key.
     *
     * @param     mixed $key Primary key to use for the query
     * @param     PropelPDO $con A connection object
     *
     * @return Ratesgroup|Ratesgroup[]|mixed the result, formatted by the current formatter
     */
    protected function findPkComplex($key, $con)
    {
        // As the query uses a PK condition, no limit(1) is necessary.
        $criteria = $this->isKeepQuery() ? clone $this : $this;
        $stmt = $criteria
            ->filterByPrimaryKey($key)
            ->doSelect($con);

        return $criteria->getFormatter()->init($criteria)->formatOne($stmt);
    }

    /**
     * Find objects by primary key
     * <code>
     * $objs = $c->findPks(array(12, 56, 832), $con);
     * </code>
     * @param     array $keys Primary keys to use for the query
     * @param     PropelPDO $con an optional connection object
     *
     * @return PropelObjectCollection|Ratesgroup[]|mixed the list of results, formatted by the current formatter
     */
    public function findPks($keys, $con = null)
    {
        if ($con === null) {
            $con = Propel::getConnection($this->getDbName(), Propel::CONNECTION_READ);
        }
        $this->basePreSelect($con);
        $criteria = $this->isKeepQuery() ? clone $this : $this;
        $stmt = $criteria
            ->filterByPrimaryKeys($keys)
            ->doSelect($con);

        return $criteria->getFormatter()->init($criteria)->format($stmt);
    }

    /**
     * Filter the query by primary key
     *
     * @param     mixed $key Primary key to use for the query
     *
     * @return RatesgroupQuery The current query, for fluid interface
     */
    public function filterByPrimaryKey($key)
    {

        return $this->addUsingAlias(RatesgroupPeer::ID, $key, Criteria::EQUAL);
    }

    /**
     * Filter the query by a list of primary keys
     *
     * @param     array $keys The list of primary key to use for the query
     *
     * @return RatesgroupQuery The current query, for fluid interface
     */
    public function filterByPrimaryKeys($keys)
    {

        return $this->addUsingAlias(RatesgroupPeer::ID, $keys, Criteria::IN);
    }

    /**
     * Filter the query on the id column
     *
     * Example usage:
     * <code>
     * $query->filterById(1234); // WHERE id = 1234
     * $query->filterById(array(12, 34)); // WHERE id IN (12, 34)
     * $query->filterById(array('min' => 12)); // WHERE id > 12
     * </code>
     *
     * @param     mixed $id The value to use as filter.
     *              Use scalar values for equality.
     *              Use array values for in_array() equivalent.
     *              Use associative array('min' => $minValue, 'max' => $maxValue) for intervals.
     * @param     string $comparison Operator to use for the column comparison, defaults to Criteria::EQUAL
     *
     * @return RatesgroupQuery The current query, for fluid interface
     */
    public function filterById($id = null, $comparison = null)
    {
        if (is_array($id) && null === $comparison) {
            $comparison = Criteria::IN;
        }

        return $this->addUsingAlias(RatesgroupPeer::ID, $id, $comparison);
    }

    /**
     * Filter the query on the branch_id column
     *
     * Example usage:
     * <code>
     * $query->filterByBranchId(1234); // WHERE branch_id = 1234
     * $query->filterByBranchId(array(12, 34)); // WHERE branch_id IN (12, 34)
     * $query->filterByBranchId(array('min' => 12)); // WHERE branch_id > 12
     * </code>
     *
     * @see       filterByBranch()
     *
     * @param     mixed $branchId The value to use as filter.
     *              Use scalar values for equality.
     *              Use array values for in_array() equivalent.
     *              Use associative array('min' => $minValue, 'max' => $maxValue) for intervals.
     * @param     string $comparison Operator to use for the column comparison, defaults to Criteria::EQUAL
     *
     * @return RatesgroupQuery The current query, for fluid interface
     */
    public function filterByBranchId($branchId = null, $comparison = null)
    {
        if (is_array($branchId)) {
            $useMinMax = false;
            if (isset($branchId['min'])) {
                $this->addUsingAlias(RatesgroupPeer::BRANCH_ID, $branchId['min'], Criteria::GREATER_EQUAL);
                $useMinMax = true;
            }
            if (isset($branchId['max'])) {
                $this->addUsingAlias(RatesgroupPeer::BRANCH_ID, $branchId['max'], Criteria::LESS_EQUAL);
                $useMinMax = true;
            }
            if ($useMinMax) {
                return $this;
            }
            if (null === $comparison) {
                $comparison = Criteria::IN;
            }
        }

        return $this->addUsingAlias(RatesgroupPeer::BRANCH_ID, $branchId, $comparison);
    }

    /**
     * Filter the query on the branch_dealer_id column
     *
     * Example usage:
     * <code>
     * $query->filterByBranchDealerId(1234); // WHERE branch_dealer_id = 1234
     * $query->filterByBranchDealerId(array(12, 34)); // WHERE branch_dealer_id IN (12, 34)
     * $query->filterByBranchDealerId(array('min' => 12)); // WHERE branch_dealer_id > 12
     * </code>
     *
     * @see       filterByBranch()
     *
     * @param     mixed $branchDealerId The value to use as filter.
     *              Use scalar values for equality.
     *              Use array values for in_array() equivalent.
     *              Use associative array('min' => $minValue, 'max' => $maxValue) for intervals.
     * @param     string $comparison Operator to use for the column comparison, defaults to Criteria::EQUAL
     *
     * @return RatesgroupQuery The current query, for fluid interface
     */
    public function filterByBranchDealerId($branchDealerId = null, $comparison = null)
    {
        if (is_array($branchDealerId)) {
            $useMinMax = false;
            if (isset($branchDealerId['min'])) {
                $this->addUsingAlias(RatesgroupPeer::BRANCH_DEALER_ID, $branchDealerId['min'], Criteria::GREATER_EQUAL);
                $useMinMax = true;
            }
            if (isset($branchDealerId['max'])) {
                $this->addUsingAlias(RatesgroupPeer::BRANCH_DEALER_ID, $branchDealerId['max'], Criteria::LESS_EQUAL);
                $useMinMax = true;
            }
            if ($useMinMax) {
                return $this;
            }
            if (null === $comparison) {
                $comparison = Criteria::IN;
            }
        }

        return $this->addUsingAlias(RatesgroupPeer::BRANCH_DEALER_ID, $branchDealerId, $comparison);
    }

    /**
     * Filter the query on the quarter column
     *
     * Example usage:
     * <code>
     * $query->filterByQuarter(1234); // WHERE quarter = 1234
     * $query->filterByQuarter(array(12, 34)); // WHERE quarter IN (12, 34)
     * $query->filterByQuarter(array('min' => 12)); // WHERE quarter > 12
     * </code>
     *
     * @param     mixed $quarter The value to use as filter.
     *              Use scalar values for equality.
     *              Use array values for in_array() equivalent.
     *              Use associative array('min' => $minValue, 'max' => $maxValue) for intervals.
     * @param     string $comparison Operator to use for the column comparison, defaults to Criteria::EQUAL
     *
     * @return RatesgroupQuery The current query, for fluid interface
     */
    public function filterByQuarter($quarter = null, $comparison = null)
    {
        if (is_array($quarter)) {
            $useMinMax = false;
            if (isset($quarter['min'])) {
                $this->addUsingAlias(RatesgroupPeer::QUARTER, $quarter['min'], Criteria::GREATER_EQUAL);
                $useMinMax = true;
            }
            if (isset($quarter['max'])) {
                $this->addUsingAlias(RatesgroupPeer::QUARTER, $quarter['max'], Criteria::LESS_EQUAL);
                $useMinMax = true;
            }
            if ($useMinMax) {
                return $this;
            }
            if (null === $comparison) {
                $comparison = Criteria::IN;
            }
        }

        return $this->addUsingAlias(RatesgroupPeer::QUARTER, $quarter, $comparison);
    }

    /**
     * Filter the query on the year column
     *
     * Example usage:
     * <code>
     * $query->filterByYear('fooValue');   // WHERE year = 'fooValue'
     * $query->filterByYear('%fooValue%'); // WHERE year LIKE '%fooValue%'
     * </code>
     *
     * @param     string $year The value to use as filter.
     *              Accepts wildcards (* and % trigger a LIKE)
     * @param     string $comparison Operator to use for the column comparison, defaults to Criteria::EQUAL
     *
     * @return RatesgroupQuery The current query, for fluid interface
     */
    public function filterByYear($year = null, $comparison = null)
    {
        if (null === $comparison) {
            if (is_array($year)) {
                $comparison = Criteria::IN;
            } elseif (preg_match('/[\%\*]/', $year)) {
                $year = str_replace('*', '%', $year);
                $comparison = Criteria::LIKE;
            }
        }

        return $this->addUsingAlias(RatesgroupPeer::YEAR, $year, $comparison);
    }

    /**
     * Filter the query by a related Branch object
     *
     * @param   Branch $branch The related object to use as filter
     * @param     string $comparison Operator to use for the column comparison, defaults to Criteria::EQUAL
     *
     * @return   RatesgroupQuery The current query, for fluid interface
     * @throws   PropelException - if the provided filter is invalid.
     */
    public function filterByBranch($branch, $comparison = null)
    {
        if ($branch instanceof Branch) {
            return $this
                ->addUsingAlias(RatesgroupPeer::BRANCH_ID, $branch->getId(), $comparison)
                ->addUsingAlias(RatesgroupPeer::BRANCH_DEALER_ID, $branch->getDealerId(), $comparison);
        } else {
            throw new PropelException('filterByBranch() only accepts arguments of type Branch');
        }
    }

    /**
     * Adds a JOIN clause to the query using the Branch relation
     *
     * @param     string $relationAlias optional alias for the relation
     * @param     string $joinType Accepted values are null, 'left join', 'right join', 'inner join'
     *
     * @return RatesgroupQuery The current query, for fluid interface
     */
    public function joinBranch($relationAlias = null, $joinType = Criteria::INNER_JOIN)
    {
        $tableMap = $this->getTableMap();
        $relationMap = $tableMap->getRelation('Branch');

        // create a ModelJoin object for this join
        $join = new ModelJoin();
        $join->setJoinType($joinType);
        $join->setRelationMap($relationMap, $this->useAliasInSQL ? $this->getModelAlias() : null, $relationAlias);
        if ($previousJoin = $this->getPreviousJoin()) {
            $join->setPreviousJoin($previousJoin);
        }

        // add the ModelJoin to the current object
        if ($relationAlias) {
            $this->addAlias($relationAlias, $relationMap->getRightTable()->getName());
            $this->addJoinObject($join, $relationAlias);
        } else {
            $this->addJoinObject($join, 'Branch');
        }

        return $this;
    }

    /**
     * Use the Branch relation Branch object
     *
     * @see       useQuery()
     *
     * @param     string $relationAlias optional alias for the relation,
     *                                   to be used as main alias in the secondary query
     * @param     string $joinType Accepted values are null, 'left join', 'right join', 'inner join'
     *
     * @return   BranchQuery A secondary query class using the current class as primary query
     */
    public function useBranchQuery($relationAlias = null, $joinType = Criteria::INNER_JOIN)
    {
        return $this
            ->joinBranch($relationAlias, $joinType)
            ->useQuery($relationAlias ? $relationAlias : 'Branch', 'BranchQuery');
    }

    /**
     * Filter the query by a related Singlerate object
     *
     * @param   Singlerate|PropelObjectCollection $singlerate  the related object to use as filter
     * @param     string $comparison Operator to use for the column comparison, defaults to Criteria::EQUAL
     *
     * @return   RatesgroupQuery The current query, for fluid interface
     * @throws   PropelException - if the provided filter is invalid.
     */
    public function filterBySinglerate($singlerate, $comparison = null)
    {
        if ($singlerate instanceof Singlerate) {
            return $this
                ->addUsingAlias(RatesgroupPeer::ID, $singlerate->getRategroupId(), $comparison);
        } elseif ($singlerate instanceof PropelObjectCollection) {
            return $this
                ->useSinglerateQuery()
                ->filterByPrimaryKeys($singlerate->getPrimaryKeys())
                ->endUse();
        } else {
            throw new PropelException('filterBySinglerate() only accepts arguments of type Singlerate or PropelCollection');
        }
    }

    /**
     * Adds a JOIN clause to the query using the Singlerate relation
     *
     * @param     string $relationAlias optional alias for the relation
     * @param     string $joinType Accepted values are null, 'left join', 'right join', 'inner join'
     *
     * @return RatesgroupQuery The current query, for fluid interface
     */
    public function joinSinglerate($relationAlias = null, $joinType = Criteria::INNER_JOIN)
    {
        $tableMap = $this->getTableMap();
        $relationMap = $tableMap->getRelation('Singlerate');

        // create a ModelJoin object for this join
        $join = new ModelJoin();
        $join->setJoinType($joinType);
        $join->setRelationMap($relationMap, $this->useAliasInSQL ? $this->getModelAlias() : null, $relationAlias);
        if ($previousJoin = $this->getPreviousJoin()) {
            $join->setPreviousJoin($previousJoin);
        }

        // add the ModelJoin to the current object
        if ($relationAlias) {
            $this->addAlias($relationAlias, $relationMap->getRightTable()->getName());
            $this->addJoinObject($join, $relationAlias);
        } else {
            $this->addJoinObject($join, 'Singlerate');
        }

        return $this;
    }

    /**
     * Use the Singlerate relation Singlerate object
     *
     * @see       useQuery()
     *
     * @param     string $relationAlias optional alias for the relation,
     *                                   to be used as main alias in the secondary query
     * @param     string $joinType Accepted values are null, 'left join', 'right join', 'inner join'
     *
     * @return   SinglerateQuery A secondary query class using the current class as primary query
     */
    public function useSinglerateQuery($relationAlias = null, $joinType = Criteria::INNER_JOIN)
    {
        return $this
            ->joinSinglerate($relationAlias, $joinType)
            ->useQuery($relationAlias ? $relationAlias : 'Singlerate', 'SinglerateQuery');
    }

    /**
     * Exclude object from result
     *
     * @param   Ratesgroup $ratesgroup Object to remove from the list of results
     *
     * @return RatesgroupQuery The current query, for fluid interface
     */
    public function prune($ratesgroup = null)
    {
        if ($ratesgroup) {
            $this->addUsingAlias(RatesgroupPeer::ID, $ratesgroup->getId(), Criteria::NOT_EQUAL);
        }

        return $this;
    }

}
